/**
 * Copyright 2008 Matthew Purland (m.purland@gmail.com)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.variance.version.diff.strategy;

import java.util.List;

import org.variance.version.diff.Difference;
import org.variance.version.diff.Differentiable;

/**
 * Interface for pluggable diff handlers. Strategy implementation. An object
 * that implements this will be able to define a separate difference strategy.
 *
 * @author Matthew Purland
 */
public interface DiffStrategy<T> {

	/**
	 * Compute the difference between two differentiable objects.
	 *
	 * @param differentiableLeft The left differentiable object
	 * @param differentiableRight The right differentiable object
	 * @return Returns the {@link Difference} of the computed difference
	 */
    List<Difference<T>> computeDifference(Differentiable<T> differentiableLeft, Differentiable<T> differentiableRight);
}
